docs: Add missing stanzas for gtk_test_accessible API
authorEmmanuele Bassi <ebassi@gnome.org>
Wed, 16 Dec 2020 15:47:29 +0000 (15:47 +0000)
committerEmmanuele Bassi <ebassi@gnome.org>
Wed, 16 Dec 2020 16:29:01 +0000 (16:29 +0000)
docs/reference/gtk/gtk4-sections.txt
gtk/gtktestatcontext.c

index 23e0b19c08fa73efdb1e1543992102010bf5421a..4c4c48d56e25b8bfe97d69c4e434f45347679895 100644 (file)
@@ -5508,7 +5508,6 @@ gtk_test_accessible_assert_property
 gtk_test_accessible_assert_relation
 gtk_test_accessible_assert_role
 gtk_test_accessible_assert_state
-gtk_test_accessible_assertion_message_role
 gtk_test_accessible_check_property
 gtk_test_accessible_check_relation
 gtk_test_accessible_check_state
@@ -5516,6 +5515,8 @@ gtk_test_accessible_has_property
 gtk_test_accessible_has_relation
 gtk_test_accessible_has_role
 gtk_test_accessible_has_state
+<SECTION Private>
+gtk_test_accessible_assertion_message_role
 </SECTION>
 
 <SECTION>
index 27ad90da6778374fbed22bdd9709244734110122..601be1144e7dbf14875f30e62e6be78c5c84d6f3 100644 (file)
@@ -114,6 +114,16 @@ gtk_test_at_context_new (GtkAccessibleRole  accessible_role,
                        NULL);
 }
 
+/**
+ * gtk_test_accessible_has_role:
+ * @accessible: a #GtkAccessible
+ * @role: a #GtkAccessibleRole
+ *
+ * Checks whether the #GtkAccessible:accessible-role of the accessible
+ * is @role.
+ *
+ * Returns: %TRUE if the role matches
+ */
 gboolean
 gtk_test_accessible_has_role (GtkAccessible     *accessible,
                               GtkAccessibleRole  role)
@@ -123,6 +133,15 @@ gtk_test_accessible_has_role (GtkAccessible     *accessible,
   return gtk_accessible_get_accessible_role (accessible) == role;
 }
 
+/**
+ * gtk_test_accessible_has_property:
+ * @accessible: a #GtkAccessible
+ * @property: a #GtkAccessibleProperty
+ *
+ * Checks whether the #GtkAccessible has @property set.
+ *
+ * Returns: %TRUE if the @property is set in the @accessible
+ */
 gboolean
 gtk_test_accessible_has_property (GtkAccessible         *accessible,
                                   GtkAccessibleProperty  property)
@@ -190,6 +209,15 @@ out:
   return res;
 }
 
+/**
+ * gtk_test_accessible_has_state:
+ * @accessible: a #GtkAccessible
+ * @state: a #GtkAccessibleState
+ *
+ * Checks whether the #GtkAccessible has @state set.
+ *
+ * Returns: %TRUE if the @state is set in the @accessible
+ */
 gboolean
 gtk_test_accessible_has_state (GtkAccessible      *accessible,
                                GtkAccessibleState  state)
@@ -257,6 +285,15 @@ out:
   return res;
 }
 
+/**
+ * gtk_test_accessible_has_relation:
+ * @accessible: a #GtkAccessible
+ * @relation: a #GtkAccessibleRelation
+ *
+ * Checks whether the #GtkAccessible has @relation set.
+ *
+ * Returns: %TRUE if the @relation is set in the @accessible
+ */
 gboolean
 gtk_test_accessible_has_relation (GtkAccessible         *accessible,
                                   GtkAccessibleRelation  relation)
@@ -324,6 +361,19 @@ out:
   return res;
 }
 
+/*< private >
+ * gtk_test_accessible_assertion_message_role:
+ * @domain: a domain
+ * @file: a file name
+ * @line: the line in @file
+ * @func: a function name in @file
+ * @expr: the expression being tested
+ * @accessible: a #GtkAccessible
+ * @expected_role: the expected #GtkAccessibleRole
+ * @actual_role: the actual #GtkAccessibleRole
+ *
+ * Prints an assertion message for gtk_test_accessible_assert_role().
+ */
 void
 gtk_test_accessible_assertion_message_role (const char        *domain,
                                             const char        *file,